The Atari Compendium

home *** CD-ROM | disk | FTP | other *** search

/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / editors / proed.lzh / PROED.DOC < prev next >

Wrap

Text File | 1985-11-20 | 54.9 KB | 1,679 lines

PRO-ED Cole Software Thank you for down loading this copy of PRO-ED. I hope you will find this program useful in your future development work. PRO-ED is distributed free of charge, for you to use as long as you wish. All I ask in return, is for you to send me $15.00 to become a registered user of this program. To register, send your name, address, phone and software interest to the address listed below. It will surely be appreciated. As a regisitered user, updates of this program will be made available to you from time to time and you'll be able to make suggestions for improving this program. Considerable time was spent in testing this computer program and all the program's features should work properly. However, no testing procedure is perfect and should a "bug" be detected in this program, please notify Cole Software in writing at the address listed on the bottom of this page, Enhancements to PRO-ED are planned and your input into the enhancement process is encouraged. Send all comments and suggestions to the address listed below. COPYRIGHT 1986 - Cole Software PRO-ED is the unpublished work of Jerry Cole, Cole Software, Beavercreek, Oregon and represents the considerable time and effort spent in it's development. You are allowed duplicate this program and to distribute it to anyone you wish, but it MAY NOT BE SOLD in any form without the written consent of it's author. This notice MUST be included with all copies of this program. Jerry Cole P.O. BOX 95 Beavercreek, Oregon 97004-0095 Phone: 503-632-4927 PRO-ED Cole Software Table of Contents =========================================== An Overview of PRO-ED...............Page 1 How to use PRO-ED...................Page 2 Responding to prompts Loading a file to edit Creating a new file Basic editing File insert Starting a second edit Saving your work Aborting an editing session Exiting the editor Explanation of Commands.............Page 9 Complete command list Function key commands Control key commands Alternate key commands Extended commands Special Features....................Page 20 Showing a Directory List Undo Delete command Entering control codes Setting Tabs Keyword Definitions Outline Display mode Profiles Editor profile options Error and Warning Messages..........Page 25 Index...............................Page 28 PRO-ED Page 1 Cole Software PRO-ED an Overview ================== PRO-ED is a text editor designed specifically for the programmer to create and edit source code. This editor can be used to produce any type of document, but it does not attempt to replace a word processor. The needs of a programmer developing source code programs are quite different from a person writing a business letter, short story or magazine article. The programmer should have a tool that will assist him or her in being more productive, and in making the task of development much easier. This editor is probably different from other programming editors that you may have used previously. The major difference is how PRO-ED works with text. PRO-ED presents you with a window into your text file. This window is always 80 columns wide no matter how short your lines are. No, each line does not take up 80 bytes of memory, but this editor is designed to give you that impression. Speaking of 80 columns, this editor will strictly enforce an 80 column limit on line length. It is the opinion of many, that source code should not exceed column 80, as longer lines may affect readability. Before using this editor take a little time to review this documentation. Explanations of all commands and special features are found on the following pages. PRO-ED Page 2 Cole Software How to use PRO-ED ================= Getting Started --------------- First of all it is a good idea to make a copy PRO-ED to another disk before using the editor. Use the backup copy as your working disk and place the master disk in safe place to insure you will always have a good copy of the editor. PRO-ED will run from RAM disk and hard disk without any problems. PRO-ED comes to you as a .TTP (Tos Takes Parms) program. This will allow you to specify a pathname of a file to edit when executing PRO-ED. If you are working in a shell environment, PRO-ED will accept a pathname from the command line. Responding to Prompts --------------------- On occasion the editor will prompt you for addition information needed to carry out a command, such as filename, search string, etc. The following editing keys will work when responding to a prompt: Backspace.......Deletes the character left of the cursor Delete..........Deletes character under cursor Insert..........Toggles between insert and overstrike modes Tab.............Erases entry from cursor position / terminates entry Clr/Home........Erases entire entry, positions cursor at beginning Cursor Keys.....Moves cursor left and right in the entry Return..........Terminates entry, full entry accepted Loading a File to Edit ---------------------- If a pathname was entered when executing PRO-ED, the program will attempt to load that file into memory for editing. If not, PRO-ED will prompt you for the pathname of a file to edit. If the file cannot be found, "-- File Not Found --" will be displayed, indicating that the editor could not locate the file requested. PRO-ED will automatically remove and expand all tabs within the file being loaded. Expansion is done on mod-8 boundaries. Also, any lines terminating with LF's only will be changed to end with CR/LF's. A list of files from a disk or directory can be shown on the screen at any pathname prompt by entering a pathname containing wild card characters.(See Special Features for more information) Creating a New File ------------------- To create a new file simply press the RETURN key at the pathname prompt without entering a pathname. PRO-ED will request a pathname when you save the file. A new file is indicated by the words "New File" displayed on the left hand side of the status line. PRO-ED Page 3 Cole Software How to use PRO-ED ================= Basic Editing - The Status Line ------------------------------- After loading a file or creating a new file the editor will display the first screen of text and position the cursor on column 1 of the first line. The top line of the screen is reserved for the status line which is explained below. File Being Edited Line. 1 Col. 1t ----- Options On ----- ^^^^^^^^^^^^^^^^^ ^^^^^^^^ ^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^ | | | | Filename being Edited | Column Cursor | is shown here | is on. 't' | | indicates TAB | | | Line of File Editor Options in effect Cursor is on ------------------------ Outline Word-Wrap Indent Compose Insert Control Editor Options -------------- Outline Mode -- Condensed text display. -- Toggled on and off with F6 function key Word Wrap Mode -- Wraps word when cursor reaches column 80 -- Toggled on and off with F7 function key Auto Indent Mode -- Cursor will indent to previous line on -- line inserts, word wrap, and split line -- Toggled on and off with F8 function key Compose Mode -- Will insert a new line each time the -- RETURN key is pressed -- Toggled on and off with F9 function key Insert Mode -- Keyboard characters are inserted into text -- Toggled on and off with Insert or ^I Control Key Mode -- Allows control key values to be entered -- into text. (Esc seq for printers, etc) -- Toggled on and off with ALT-C (for further information see command descriptions) PRO-ED Page 4 Cole Software How to use PRO-ED ================= Basic Editing - The Commands ---------------------------- There are two different command groups for this editor. Key Commands -- Function, Control and Alternate key Commands. These commands can be executed at any time during editing by pressing the proper key(s). Extended Commands -- Extended commands are executed by pressing function key F10 or Control-X followed by the command to be executed. The editor will prompt for any information needed to carry out the command. Basic Editing - The Cursor -------------------------- The cursor can be moved anywhere on the screen (except past eof) at any time while editing, there is no relationship between the lines of text on the screen and movement of the cursor. Cursor Movement: Right: Arrow key, Ctl-F, Mouse By Word: Alt-F Left: Arrow key, Ctl-B, Mouse By Word: Alt-B Up: Arrow key, Ctl-P, Mouse Down: Arrow key, Ctl-N, Mouse To Tab: Tab key Basic Editing - Scrolling Through Text -------------------------------------- The display can be scrolled (moved) by any of the commands listed below. Scroll Screen Forward: F1 or Alt-N Scroll Screen Backward: F2 or Alt-P Scroll to End of File: Shift/F1 or Alt-E Scroll to Begin of File: Shift/F2 or Alt-S Scroll Cursor Line to Top: ^Z Scroll to Locator: F3 (locator marked with F5) Scroll to Line Number: Extended Command -SL- (Show Line) Scroll Down by Line: Down Cursor when at bottom line Scroll Up by Line: Up Cursor when at top line The number of lines scrolled for a screen is variable. The roll size defaults to 20 lines but can be changed with the extended command "MR" (modify roll size). PRO-ED Page 5 Cole Software How to use PRO-ED ================= Basic Editing - Insert Vs. Overstrike ------------------------------------- The terms Insert and Overstrike are used to describe what the editor will do with characters entered via the keyboard. A character entered while in the Overstrike mode will replace the existing character on the screen and in the text. This is useful, because it eliminates the need to first delete a character before inserting a new one. A character entered while in the Insert mode will be inserted into the text where the cursor is positioned, all the text to the right of the cursor will be shifted to the right. Insert mode can be engaged by pressing the insert key or by pressing CTL-I. When in the insert mode, the editor will display "Ins" on the status line. The Insert mode will remain active until the insert key or CTL-I is pressed again. Basic Editing - Opening New Lines --------------------------------- When in the Compose mode, PRO-ED will automatically insert a new line each time the RETURN key is pressed. The Compose mode is activated by pressing function key F9. "Com" is displayed on the status line when the Compose mode is active. In addition to the RETURN key, Ctl-O and Ctl-U can be used to open new lines of text. Ctl-O will insert a new line directly above the line the cursor is positioned on. Ctl-U will insert a new line under the line the cursor is positioned on. NOTE: The RETURN key will not split a line, use the command Ctl-Y to split a line. Basic Editing - Deleting ------------------------ Delete Character under cursor: Delete key or Ctl-D Delete Character left of cursor: Backspace while in Insert Mode Delete Current Word: Alt-D Delete Current Line: Ctl-R Delete Marked Block: Extended Command -DB- The last full line or block delete can be recovered by pressing the UNDO key. A character or word delete can also be recovered, but the undo must be done before leaving the line. Any other changes made to that line will also be undone. PRO-ED Page 6 Cole Software How to use PRO-ED ================= Basic Editing - Working with Blocks ----------------------------------- Before a block command can be executed a block of text must first be marked. A block can be marked as follows: Beginning of Block: F4, Ctl-M or Left Mouse Button End of Block: F4, Ctl-M or Left Mouse Button Remove Block Markers: Shift/F4 or Alt-M The cursor does not have to be in column 1, but only entire lines of text can be marked. Once a block is marked any of the following commands can be performed: Align Block to cursor: Ctl-A Move Block to cursor: Right Mouse Button or Ext. Command "MB" Copy Block to cursor: Extended Command "CB" Delete Block: Extended Command "DB" Print Block: Extended Command "PB" Save Block to Disk: Extended Command "SB" After a block command has been executed, the block markers are removed automatically. Basic Editing - String Commands ------------------------------- Find string and replace string commands are built into this editor. In addition, a count string command has been included. Find String: Extended Command -FS- Editor will prompt for the search value. Replace String: Extended Command -RS- Editor will prompt for the search value, the replacement value and ask if you want to verify each occurrence before replacement takes place. Count String: Extended Command -CS- Editor will prompt for the search value and will display a count of occurrences found. This command will always begin it's search at the beginning of the text. Wildcards: The question mark -?- is the designated wildcard character and it can be used in any of the commands described above. Important Note: If Replace or Count string commands are executed within a marked block their operation will be limited to the lines of text within the block. PRO-ED Page 7 Cole Software How to use PRO-ED ================= File Insert ----------- To insert an external text file into the current edit, position the cursor at the location within the text, press the F10 key and enter "IF" at the command prompt. PRO-ED will then prompt for the pathname of the file to insert. PRO-ED will then load and insert the file into the current edit at the cursor location. Editing a Second File --------------------- To begin a second edit, press the F10 key and enter "XE" at the command prompt. "XE" (execute edit) will then prompt for a pathname to edit. The file will load and the first screen of text will be displayed. The status line will show the name of the second file you are editing. When the second edit has ended, the first edit will return to the screen. Only two edits are allowed at one time. There is no way to edit two files concurrently with this release of PRO-ED. Saving Your Work ---------------- The are two commands for saving the current edit. Save Edit: Extended Command -SE- This command will save the current edit and allow you to continue editing the same file. Quit Edit: Extended Command -QE- This command will save the current edit and quit the current edit. To edit the same file again, it must be reloaded from disk. Both of these commands will prompt you for a pathname for the file. The default pathname will be shown on the command line. If the default is desired, just press RETURN. To cancel the save command press the "ESC" key. Once the editor begins writing to the output file, there is no way to terminate the save. If the Auto-Backup option is "turned on" the original file will be renamed with a ".BAK" extension before the new file is written. PRO-ED Page 8 Cole Software How to use PRO-ED ================= Aborting an Edit ---------------- To quit an edit without saving the modifications, the extended command -QA- (Quit and Abort) is used. If any changes have been made, the editor will ask for verification before executing this command. "QA" -- Quit Current Edit and Abort Changes Exiting the Editor ------------------ The editor will not allow an exit during an edit. To exit the editor and return to the Desk Top or Shell, press the "ESC" key when the editor prompts for a pathname to edit. If the "ESC" key is pressed at the second edit pathname prompt, the editor will return to the first edit. PRO-ED Page 9 Cole Software PRO-ED Commands =============== Function Keys F1...Scroll Forward Shift/F1...Scroll to End of File F2...Scroll Backward Shift/F2...Scroll to Start of File F3...Scroll to Locator F4...Mark Block Shift/F4...Clear Block Markers F5...Mark Locator F6...Outline Mode Toggle F7...Word Wrap Toggle F8...Auto Indent Toggle F9...Compose Mode Toggle F10..Extended Commands Shift/F10..Line per Screen Toggle Control Keys ^B...Cursor Backward (left) ^A...Align Block/Line to Cursor ^F...Cursor Forward (right) ^O...Open Line above Cursor ^S...Cursor to Start of Line ^U...Open Line under Cursor ^E...Cursor to End of Line ^Y...Split Line at Cursor ^P...Cursor Previous Line (up) ^J...Join Current Line to Previous ^N...Cursor Next Line (down) ^L...Locate Next Occurrence of String ^D...Delete Character ^C...Copy Previous Line--Cursor to Eol ^R...Delete Line ^I...Insert Mode Toggle ^K...Erase to End of Line ^M...Mark Block ^T...Set/Release Tab Mark ^X...Extended Commands ^Z...Scroll Cursor Line to Top Alternate Keys Alt-P...Scroll Backward Alt-E...Show End of File Alt-N...Scroll Forward Alt-S...Show Start of File Alt-L...Scroll to Locator Alt-O...Outline Mode Toggle Alt-M...Clear Block Markers Alt-F...Cursor Forward to Next Word Alt-D...Delete Word or Spaces Alt-B...Cursor Backward to Previous Word Alt-C...Toggle Control Code Entry Other Keys Arrows...Up Down Left Right Delete...Delete Character Insert...Insert Mode Toggle BS.......Backspace Delete Tab......Move Cursor to Tab Undo.....Undo Last Delete Extended Command Functions SE...Save Edit and Continue XE...Execute Second Edit QS...Quit and Save DB...Delete Block QA...Quit and Abort Changes CB...Copy Block IF...Insert File MB...Move Block PF...Print File SB...Save Block to File HP...Halt Printing PB...Print Block KP...Kill Printing FS...Find String RP...Resume Printing RS...Replace String SL...Show Line CS...Count Occurrences of String MR...Modify Roll Size SP...Save Profile DK...Define Keyword LP...Load Profile SK...Show Keyword Definitions PO...Modify Profile Options PRO-ED Page 10 Cole Software PRO-ED Command Descriptions =========================== Function Keys ------------- F1 -- Scroll Forward This command moves the display forward through the file by the number of lines specified for the roll size. (see "MR" command) F2 -- Scroll Backward This command moves the display backward through the file by the number of lines specified for the roll size. (see "MR" command) F3 -- Scroll to Locator This command moves the screen display to the last locator marked. Two locators are allowed, and if the F3 key is pressed a second time, the display will move to the second locator. (see F5) F4 -- Mark Block This command is used to mark a block of text for processing. To mark a block, position the cursor on the first line of the block and press the F4 key. That line will then be displayed in reverse video. Then place the cursor on the last line of the block and press the F4 key again. The entire block will then be displayed in reverse video. There is no limit on the size of a block. A block may be only one line long, if desired, in which case you only need to press the F4 key once. A block may be resized by placing the cursor on a line before or after the block and pressing the F4 key. If a smaller block is desired, move the cursor to the first or last line of the block and press F4. This will reset the starting or ending line of the block and a new line can then be selected. To clear the block markers press Shift/F4 or Alt-M. F5 -- Mark Locator This command is used to mark a specific location within the file, which you can scroll to on command. Two locations within a file are allowed to be marked. (see F3) PRO-ED Page 11 Cole Software PRO-ED Command Descriptions =========================== Function Keys ------------- F6 -- Outline Mode Toggle This command toggles the Outline Mode on and off. In the Outline Mode the editor will only display lines that have a non-space character at, or to the left of the cursor position at the time the Outline Mode was selected. Editing is not allowed while in the Outline Mode. F7 -- Word Wrap Toggle This command turns the Word Wrap on and off. When on, Word Wrap will automatically wrap the current word to the next line (if necessary) when the cursor reaches the right most position of the screen. F8 -- Auto Indent Toggle This command turns the Auto Indent on and off. When on, Auto Indent will cause the cursor to be positioned at the left most position of the previous line, whenever a new line is opened. Auto Indent works with Word Wrap, Split Line and Open Line commands. F9 -- Compose Mode Toggle This command turns the Compose Mode on and off. When on, Compose Mode will cause the editor to insert a new line each time the RETURN key is pressed. The cursor does not have to be at the end of a line, as this editor will not split a line with the RETURN key. (use Ctl-Key ^Y to split a line) F10-- Extended Commands This command tells the editor that you wish to execute an extended command. The editor will prompt you for a command name. To exit without a command, press the ESC key or the RETURN key immediately. (see Extended Command Functions) PRO-ED Page 12 Cole Software PRO-ED Command Descriptions =========================== Function Keys ------------- Shift/F1 -- Scroll to End of File This command moves the display to the end of the file. The cursor will be positioned in column 1 on the last line of the file. Shift/F2 -- Scroll to Start of File This command moves the display to the start of the file. The cursor will be positioned in column 1 on the first line of the file. Shift/F4 -- Clear Block Markers This command will clear any block markers that may have been set. Shift/F10-- Lines per Screen Toggle If a monochrome monitor is attached to the computer, this command will enable the editor to display 49 lines of text on the screen. For a normal display, press Shift/F10 a second time. Note: With a color monitor, this command is ignored by the editor. Control Keys - Cursor Movement ------------------------------ ^F -- Cursor Forward Moves the cursor one position to the right. ^B -- Cursor Backward Moves the cursor one position to the left. ^P -- Cursor to Previous Line Moves the cursor up one line. ^N -- Cursor to Next Line Moves the cursor down one line. ^S -- Cursor to Start of Line Moves the cursor to the first non-space character of the line. ^E -- Cursor to End of Line Moves the cursor to the end of the line. PRO-ED Page 13 Cole Software PRO-ED Command Descriptions =========================== Control Keys - Editing Commands ------------------------------- ^D -- Delete Character Deletes the character the cursor is on. ^K -- Delete to End of Line Deletes all characters from the cursor to the end of the line. ^R -- Delete Line (Remove) Deletes the entire line the cursor is on. ^C -- Copy Line This command will duplicate the line of text, that is directly above the line the cursor is positioned on, from the cursor's column position to the end of the line. ^Y -- Split Line This command will split the current line at the cursor position. All characters, from the cursor position to the end of the line, will be removed from the current line and placed in a new line below it. The cursor will remain in it's original location. ^J -- Join Line This command will join the current line and the line above it. If the operation will result in a line being created that is longer than 80 characters, the editor will ignore the command. ^A -- Align Line/Block to cursor This command will shift a line or block to match the cursor position. If the cursor is placed within a marked block, the entire block will be shifted to match the cursor position. Lines within a block retain their relative positions to one another. If the operation will result in a line longer than 80 characters, the editor will ignore the command. PRO-ED Page 14 Cole Software PRO-ED Command Descriptions =========================== Control Keys - Editing Commands ------------------------------- ^O -- Open Line above cursor This command will insert a new line above the cursor line. The cursor will be positioned on the indent of the line above, or on the left most tab setting, or in column 1, depending on what options are in effect. ^U -- Open Line under cursor This command works the same way as ^O except the new line is inserted under the cursor line. Control Keys - Special Functions -------------------------------- ^I -- Insert Mode Toggle This command toggles the editor between the character insert and overstrike mode. ^T -- Set/Release Tab Mark This command is used to set a tab mark at the current cursor position. To release a tab mark, position the cursor over the tab position and execute the command, the tab mark is removed. ^Z -- Scroll Cursor Line to Top This command will scroll the display, so that the line the cursor is on will become the top line of the screen display. ^M -- Mark Block This command marks the beginning and/or the end of a block of text. (same command as function key F4) ^L -- Locate Next Occurrence of Search String This command is used to search for the next occurrence of a string specified by the last Find String Command. Searching begins at the cursor position and searches forward through the file. ^X -- Extended Commands This command makes extended commands available. Alternate Keys - Cursor Movement -------------------------------- Alt-F -- Cursor Forward Next Word Moves the cursor forward to the beginning of the next word. Alt-B -- Cursor Backward Previous Word Moves the cursor backward to the beginning of the previous word. PRO-ED Page 15 Cole Software PRO-ED Command Descriptions =========================== Alternate Keys - Screen Movement -------------------------------- Alt-P -- Scroll to Previous Screen The screen display is scrolled backward by the number of lines specified for the roll size. (same command as function key F2) Alt-F -- Scroll Forward Screen The screen display is scrolled forward by the number of lines specified for the roll size. (same command as function key F1) Alt-B -- Scroll to Beginning of File The screen display is positioned at the beginning of the file. (same command as function key Shift/F2) Alt-E -- Scroll to End of File The screen display is positioned at the end of the file. (same command as function key Shift/F1) Alt-L -- Scroll to Locator The screen display is positioned at the last used locator. If the screen is already positioned on a locator, the editor will scroll to the other locator, if another is marked. (same command as function key F3) Alternate Keys - Editing Commands --------------------------------- Alt-D -- Delete Word or Spaces This command will delete the word the cursor is placed on, or will delete all of the spaces from the cursor to the next word. Alternate Keys - Special Functions ---------------------------------- Alt-O -- Outline Mode Toggle This command toggles the editor in and out of the outline display mode. See Outline Display for further information. (same command as function key F6) Alt-M -- Clear Block Markers This command clears the block markers. (same command as function key Shift/F4) Alt-C -- Control Code Enable Toggle This command toggles the ability to enter control codes. (See Entering Control Codes for more information) PRO-ED Page 16 Cole Software PRO-ED Command Descriptions =========================== Mouse Commands -------------- Movement -- The mouse can be used to move the cursor anywhere on the screen. Left Button -- This will mark the beginning and/or the end of a block. (same as function key F4) Right Button -- This will move a marked block to the cursor location. (same as extended command -MB-) Other Key Commands ------------------ Arrows -- Cursor Up, Down, Left and Right Move the cursor as described. Same as control keys. Backspace -- Backspace and Delete If in the insert mode, a character is deleted. If in the overstrike mode, a character is erased. Delete -- Delete character Deletes the character the cursor is on. Tab -- Cursor to Tab Mark This will move the cursor to the next tab marker. Insert -- Insert Mode Toggle Toggles the editor between the insert and overstrike character mode. (same as ^I command) Undo -- Undo Last Delete Recovers the text deleted in error. The Undo will only recover text from the most recent delete. Help -- Ask For Help The editor will display one of several HELP screens. PRO-ED Page 17 Cole Software PRO-ED Command Descriptions =========================== Extended Command Functions -------------------------- Before any of the extended commands may be executed, a request for extended commands must be issued. This is done by pressing function key F10 or Control-X. The editor will then prompt for an extended command. SE -- Save Edit This command is used to save the current edit. The editor will prompt for a file pathname. After the save is completed, editing may be resumed. QS -- Quit Save Edit This command is used to save the current edit. The editor will prompt for a file pathname. The current edit is ended once the save has been completed. QA -- Quit Edit and Abort Changes This command is used to abort the current edit. If any changes have been made, the editor will prompt for verification. XE -- Execute Second Edit This command allows a second file to be loaded into the editor. The first edit is suspended until completion of the second, and then the original edit can be resumed where you left off. IF -- Insert File This command will merge an external file into the text you are currently editing. The file will be inserted before the cursor line. PF -- Print File This command will print a file. You'll be prompted for the file name to print and the number of lines to be printed on each page. Enter a line count of Zero if you do not want the editor to page break for you. Editing is allowed to continue. HP -- Halt Print This command will cause the editor to stop sending data to the printer. Of course, if you have a printer buffer, the printer will not stop printing immediately. RP -- Resume Print This command is used to resume output to the printer after a halt print -HP- command has been executed. KP -- Kill Print This command will terminate the printing of a file. The printer however, will continue printing if you are using a print buffer. PRO-ED Page 18 Cole Software PRO-ED Command Descriptions =========================== Extended Command Functions -------------------------- SL -- Show Line Number This command is used to "goto" a text line number. The editor will prompt for a line number. To go to the beginning line, enter a "B". To go to the end of the text, enter an "E". MR -- Modify Roll Size This command is used to change the number of lines rolled on a full screen scroll. The default is 20 lines, but this can be changed to any reasonable number of lines. DK -- Define Keyword This command is used to assign a "value" to an Escape-Key-Sequence. The editor will first prompt for the key that is to be defined and then for the "value" to be assigned to the key. The "value" can be any combination of characters, up to 50 characters in length. (see Special Features for more information) SK -- Show Keyword Definitions This command will display the keyword definitions currently in use. DB -- Delete Block Deletes a marked block of text. MB -- Move Block Moves a marked block to the current cursor line. CB -- Copy Block Copies a marked block to the current cursor line. SB -- Save Block This command is used to save a block of text to a disk file. The editor will prompt for a file pathname. If the file already exists the editor will ask if the file is to be replaced or should the block be appended to the end of the file. PB -- Print Block Send the marked block of text to the printer. Editing is not allowed while the block is being printed. PRO-ED Page 19 Cole Software PRO-ED Command Descriptions =========================== Extended Command Functions -------------------------- FS -- Find String The editor will prompt for a search string, it will then search forward from the current cursor location to the end of the text. If the string is found, the cursor will position itself at the beginning of the string. If the editor cannot find a match, a "string not found" message will be displayed. RS -- Replace String The editor will prompt for a search string, a replacement string and if verification of replacements, is desired. If verification is requested, the editor will display each occurrence found in reverse video, and then prompt you for verification before making a replacement. A "Y" response, will cause a replacement to be made. If the ESC key is pressed, the search and replace function will be halted. After this command has completed, the cursor will be positioned on the last replacement string. Note: If this command is executed within a marked block the operation will be limited to the lines within the block. CS -- Count String The editor will prompt for a search value. After searching from the beginning, to the end of the text, the editor will display the number of occurrences found. The maximum number of occurrences reported, is 32,000. Note: If this command is executed within a marked block the operation will be limited to the lines within the block. SP -- Save Profile The command is used to save the current profile options, tab settings, keyword definitions, and other editor options to a disk file for future use. The editor will prompt for a file pathname. LP -- Load Profile This command will load a profile from the disk into the editor. The options and defaults in this profile are immediately available. The editor will prompt for a file pathname. PO -- Profile Options This command is used to change the current profile options. The new options can be saved immediately, as the editor will prompt for a profile pathname. (see Special Features for more information) PRO-ED Page 20 Cole Software PRO-ED Special Features ======================= Showing a Directory List ------------------------ PRO-ED can display a directory list at any prompt for a file pathname. To obtain the directory display, enter a pathname containing any type of wildcard character. The display will show the filename and extension along with the file size and date of the last file update. For example: A:*.* displays a directory list of drive A A:\src\*.* displays the files in the \src\ directory only Note: This does not change the current directory. The full pathname of a file must still be entered. Undo Delete Command ------------------- The most recent delete can be recovered by pressing the Undo Key. Both block and individual line deletes can be recovered. The editor will attempt to put the deleted lines back in their original location, or as close as possible. The Undo key will also undo any changes made on the current line. Once the cursor moves off a line, the changes cannot be undone. Exceptions: Deletes cannot be undone after a block move or copy, file save or file insert. Undo will only recover the first 255 lines of a block delete. Entering Control Codes ---------------------- PRO-ED provides a method of entering "control codes" into text files. Control code entry is enabled by pressing Alt-C. To disable the control codes, press Alt-C a second time. While in the control code mode, most of the control key commands will not function. Control Codes are represented on the screen with the extended character set. Control codes are defined as those character values less than 0x20 or greater than 0x7F. Note: 0x0A, 0x0D and 0x09 are not allowed to be entered. PRO-ED Page 21 Cole Software PRO-ED Special Features ======================= Setting Tabs ------------ Internally, PRO-ED does not acknowledge the existence of the tab character 0x09. However, variable cursor tabs are allowed to be set at any screen position. To mark a tab, position the cursor on the desired column and press Control-T. A "t" will display next to the column indicator on the status line. Anytime a "t" is displayed next to the column, this indicates the cursor is on a tab mark. To release a tab, position the cursor on the desired tab and press Control-T again. This will release the tab mark. The TAB key will advance the cursor to the next tab mark. If the cursor is already past the right most tab, or in column 80, the cursor will position itself at the left most tab. Tab settings can be saved in "profiles" for future use. Keyword Definitions ------------------- Keyword definitions are simply words or a phrases assigned to an Escape key sequence. The editor allows the "value" to be recalled whenever the defined Escape key sequence is entered. For example: Escape-T could be defined as "this is it". Then, whenever Escape-T is entered, while editing, the value "this is it" will be recalled to replace it. Keywords are defined and modified with the extended command -DK-. Up to 25 different keywords may be defined at one time. The maximum size of a definition is 50 characters. To delete a keyword, press the TAB key in the first position of the value field, when the editor prompts for the keyword value. Keyword definitions can be saved in "profiles" for future use. So it is possible to have one set of definitions for "C" programming and another for assembler. (see page 23 for profile information) To display the current keywords, use the extended command -SK-. PRO-ED Page 22 Cole Software PRO-ED Special Features ======================= Outline Display Mode -------------------- The editor's outline display mode allows text to be viewed in a condensed form. The outline display is activated by pressing the F6 key, and can be turned off by pressing the F6 key a second time. When in the outline mode, the editor will only show those lines of text that begin at, or before the cursor's column position when the F6 key was pressed. For example: I. This line begins in column 16 A. This line begins in column 20 II. This line also begins in column 16 A. This line begins in column 20 The cursor is in column 16 and the F6 key is pressed. The editor will redisplay the screen, but only showing those lines that begin in columns 1 through 16. Any lines that begin after column 16 will not be shown. The display would then look like this: I. This line begins in column 16 II. This line also begins in column 16 When exiting from the outline mode, the line where the cursor is placed will scroll to the top of the screen, and the text will be displayed normally. Note: Editing is not allowed while in the outline mode. Block commands will execute normally. Use of a find string or replace string command will terminate the outline display mode. PRO-ED Page 23 Cole Software PRO-ED Special Features ======================= Profiles -------- Profiles can be considered a type of configuration file. There are a number of things stored in the profile, for example: keyword definitions, tab settings, editor options and screen colors. The purpose of the profile concept is to give the user some flexibility in establishing "setups" for different types of editing. Since profiles are stored on disk and require only a modest amount of disk space, it is possible to setup a unique profile for each type of editing to be done. When the editor is loaded and executed, the editor will look for a file named "proed.pf" in the editor's directory. If found, this profile will be loaded and the editor will "come up" with the defaults contained in that profile. (see **** note below) To create a new profile follow these instructions: 1. Set the editor modes as required. 2. Mark the tab stops. 3. Define keywords, if any. 4. Change the profile options as required. 5. Press F10. (extended commands) 6. Enter "SP" (save profile) 7. The editor will prompt for a pathname, enter a pathname. 8. The new profile will now be saved and can be recalled later. To load a profile, follow these instructions: 1. Press F10. (extended commands) 2. Enter "LP". (load profile) 3. The editor will prompt for a profile pathname, enter a pathname. 4. If the profile is found, it will be loaded, and the defaults in the profile will be available for use. ***** Note: A profile other than the default, PROED.PF, may be loaded from the command line by entering -FILENAME on the command line, PRO-ED will append a .PF extension if no extension is entered. This profile filename may be entered in addition to the filename to edit. PRO-ED Page 24 Cole Software PRO-ED Special Features ======================= Editor Profile Options ---------------------- The following editor options are modified by using extended command -PO-. (profile options) Generate Automatic Backup File: Yes or No This option determines if a backup of the current file being edited, is to be created. If "Yes" the editor will automatically create a copy of the original file with a ".BAK" extension. The backup is made when a file save is done. Maximum Memory Size to Allocate: 10 through 999 Kbytes This parameter is used to limit the amount of memory that PRO-ED will allocate from the system. Normally, the editor will use all of the available memory and will not release it until after an edit has been completed. This limit is necessary in multi-tasking environments to prevent the editor from using all available memory. Compress Output Files with Tabs: Yes or No When this option is "Yes", the editor will compress all files written to disk with the tab character 0x09. PRO-ED will examine the text and insert mod-8 tabs wherever possible. No other compression techniques are used. Turn Cursor Off on Exit: Yes or No Should the editor turn the cursor off before terminating? When using a shell, this option should be set to "No", to keep the cursor visible. Color for Foreground Text: 000 through 777 This parameter controls the color of text displayed on the screen. Each digit in the number represents the intensity level of red, green, and blue respectively. Example: 004 is blue text, 777 is white. Yes, this is a horrible interface. Color for Background: 000 through 777 This parameter is used for the background color. The digits have the same meaning as described above. After the modifications are complete, the editor will prompt for a pathname where the profile can be saved. Press ESC to exit. PRO-ED Page 25 Cole Software PRO-ED Error and Warning Messages ================================= Alphabetical List of Messages ----------------------------- Alignment not performed....Line would exceed column 80 An attempt to align a line or block with the Ctl-A command was made. The result would have created a line that exceeds 80 bytes in length. The message is removed with the next keystroke. All memory has been used....Please save your work or abort the edit All free memory has been used by the editor. It is safe to save the current file, except if a block copy command caused the error. Press RETURN to continue. -Could not Open Output File- A Save operation could not open the file for output. This is normally caused by an invalid pathname being entered. Enter a correct file pathname. Error occurred while reading input file.............RETURN to Continue This could be a serious error. It could be caused by a drive going off line during a file load. Error occurred while writing output file............RETURN to Continue Normally, this error is caused by the target disk not having enough disk space to hold the current file. Use a disk that has enough room. The editor will not exit until a save has been completed normally. File is not a PRO-ED Profile....... The file that is being loaded is not a PRO-ED Profile. Execute the load profile command again and enter a Profile pathname. ** FILE NOT FOUND ** The file entered does not exist. Enter a valid pathname. PRO-ED Page 26 Cole Software PRO-ED Error and Warning Messages ================================= Alphabetical List of Messages ----------------------------- Join Lines not performed....Line would exceed column 80 An attempt to join two lines with the Ctl-A command was made. The result would have created a line that exceeds 80 bytes in length. The message is removed with the next keystroke. Keyword not Assigned - No Keyword Memory is Available The limit of 25 keyword definitions has been reached. Remove one of the existing definitions, or setup another profile. Press RETURN to continue. Line cannot exceed 160 characters...... The limit of 160 characters in the line buffer has been reached. Split the line or delete characters from the line. The message is removed with the next keystroke. No Memory available for another Edit....... There is not enough free memory to perform another edit. Save the current edit. Press RETURN to continue. No Memory available to load file..... There is not enough free memory available to begin the file load. Press RETURN to continue. Please Wait........Reorganization of Memory in Progress This is an information message from PRO-ED memory management. The message will be removed when the reorganization is complete. Search Value not Found..... The editor could not find an occurrence of the search string during a find string operation. The message is removed with the next keystroke. -- Unknown Command -- An invalid extended command has been entered. PRO-ED Page 27 Cole Software PRO-ED Error and Warning Messages ================================= Alphabetical List of Messages ----------------------------- Warning....File was not entirely loaded into editor...Continue Save? This message appears when an attempt was made to save a file that was not entirely loaded into the editor originally. A response of "Y" will allow the save to continue. Warning -- Input file was converted to CR/LF format... During the file load process, the editor changed all lines ending with a LF to CR/LF. Press RETURN to continue. Warning -- Lines longer than 80 characters were split into lines of 80....... During the load process, the editor encountered lines that were longer than 80 bytes in length. Press RETURN to continue. Warning....Unable to load entire file There is not enough free memory available to load the entire file. The editor has loaded as much of the file as possible. PRO-ED Page 28 Cole Software Index ------------------------------------------------- Align block/line...................13, 25 Arrow keys......................... 4, 16 Auto Indent mode................... 3, 11 Backspace key ..................... 5, 16 Block Commands Align............................ 6, 13, 25 Clear markers.................... 6, 12, 15 Copy ............................ 6, 18 Delete........................... 5, 18, 20 Mark............................. 6, 10, 14 Move............................. 6, 16, 18 Print............................ 6, 18 Save............................. 6, 18 Change Screen Colors...............24 Compose mode....................... 3, 5, 11 Control code entry................. 3, 15, 20 Control Keys.......................12 Copy line..........................13 Count string....................... 6, 19 Cursor Movement Down............................. 4, 12, 16 End of line...................... 4, 12 Left............................. 4, 12, 16 Left word........................ 4, 12 Right............................ 4, 12, 16 Right word....................... 4, 12 Start of line.................... 4, 12 Up............................... 4, 12, 16 Define keywords....................18, 21 Delete Commands Block............................ 5, 18, 20 Character........................ 5, 13, 16 End of line...................... 5, 13 Line............................. 5, 13 Spaces........................... 5, 15 Undo............................. 5, 16, 20 Word............................. 5, 15 Directory file list................ 2, 20 Error messages.....................25 Execute second edit................ 7, 17 Extended commands.................. 4, 17 File Operations Directory list................... 2, 20 Insert........................... 7, 17 Print............................17 Profile load.....................19, 23 Save Block....................... 6, 18 Save Edit........................ 7, 17 Save Profile.....................19, 23 Text load........................ 2, 17 Find string........................ 6, 14, 19 Function Keys......................10 Goto line number...................18 Halt print.........................17 Insert file........................ 7, 17 PRO-ED Page 29 Cole Software Index ------------------------------------------------- Insert mode........................ 5, 14, 16 Join lines.........................13 Kill print.........................17 Line per screen....................12 Load Commands Profile..........................19, 23 Text File........................ 2, 17 Mark Commands Block............................ 6, 10, 14 Locator..........................10 Modes of Operation Auto Indent...................... 3, 11 Compose.......................... 3, 5, 11 Control Code..................... 3, 15, 20 Insert........................... 5, 14, 16 Outline..........................11, 15, 22 Overstrike....................... 5, 14, 16 Word Wrap........................ 3, 11 Move block......................... 6, 16, 18 Modify profile options.............19, 24 Modify roll size................... 4, 18 Open Line.......................... 5, 11, 14 Print Commands Block............................ 6, 18 File.............................17 Quit Commands Edit with abort.................. 8, 17 Edit with save................... 7, 17 Editor........................... 8 Replace string..................... 6, 19 Resume print.......................17 Save Commands Block............................ 6, 18 Edit............................. 7, 17 Profile..........................19, 23 Screen Colors......................24 Screen Scrolling Commands Cursor line to top............... 4, 14 End of file...................... 4, 12, 15, 18 Locator.......................... 4, 10 Screen forward................... 4, 10, 15 Screen backward.................. 4, 10, 15 Start of file.................... 4, 12, 15, 18 Show keywords......................18, 21 Show Line..........................18 Split Line.........................13 String Commands Count............................ 6, 19 Find............................. 6, 14, 19 Find & Replace................... 6, 19 Wildcard......................... 6 Tabs............................... 4, 14, 16, 21 Undo Key........................... 5, 16, 20 Warning messages...................25 Wildcard search.................... 6 Word Wrap.......................... 3, 11